Skip to content

fix(docs): use a local SVG for the asciinema demo in README - #770

Open
Prince-Dany wants to merge 1 commit into
version-fox:mainfrom
Prince-Dany:fix/readme-asciinema-demo
Open

Prince-Dany wants to merge 1 commit into
version-fox:mainfrom
Prince-Dany:fix/readme-asciinema-demo

Conversation

@Prince-Dany

Copy link
Copy Markdown

Summary

  • The asciinema demo in both README.md and README_CN.md shows a broken image because GitHub's image proxy (camo.githubusercontent.com) cannot fetch the SVG from asciinema.org.
  • This PR commits the demo SVG (10 KB) to the repository and references it locally, so the demo renders reliably on GitHub.
  • The clickable link to the asciinema recording is preserved.

Changes

  • Added demo.svg — the asciinema recording SVG (downloaded from https://asciinema.org/a/650100.svg)
  • Updated README.md line 34: changed image source from the external URL to demo.svg
  • Updated README_CN.md line 30: same change

Why

GitHub's image proxy returns 503 Error Fetching Resource for the asciinema SVG. The issue documents 7/7 failed proxy attempts vs. direct requests succeeding. Committing the SVG locally bypasses the proxy entirely.

Testing

  • Verified the SVG is valid XML (<?xml version="1.0"?> header, proper SVG namespace)
  • Confirmed the local reference renders correctly in markdown preview
  • No binary files committed (SVG is text, as recommended in the issue)

Closes #760

🤖 Generated with Claude Code

GitHub's image proxy fails to fetch the asciinema.org SVG, showing a
broken image. Commit the SVG to the repository and reference it locally
so the demo renders reliably.

Closes version-fox#760

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@linghengqian linghengqian added bug Something isn't working documentation Improvements or additions to documentation labels Nov 14, 2026
@linghengqian linghengqian added this to the 1.1.1 milestone Nov 14, 2026
@codecov

codecov Bot commented Nov 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.62%. Comparing base (c4f6275) to head (562be94).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #770   +/-   ##
=======================================
  Coverage   56.62%   56.62%           
=======================================
  Files         116      116           
  Lines        8595     8595           
=======================================
  Hits         4867     4867           
  Misses       3263     3263           
  Partials      465      465           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@linghengqian linghengqian left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you remove Claude from the list of co-authors? It makes it difficult to track the actual contributors later on.

@linghengqian linghengqian added need-more-info and removed bug Something isn't working documentation Improvements or additions to documentation labels Nov 14, 2026
@linghengqian linghengqian modified the milestone: 1.1.1 Nov 14, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG]: asciinema demo in README shows a broken image on GitHub

2 participants